home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / request.zip / REQUEST.DOC < prev    next >
Text File  |  1992-06-05  |  11KB  |  272 lines
  1. April, 1992
  2.                                                                      1.
  3.  
  4.  
  5.  
  6.                                REQUEST BRAIN
  7.                      (C) Copyright 1992 by Stanley Sheff
  8.                        Support BBS: The Brainex System
  9.                                (310) 275-2344
  10.                                (310) 273-5234
  11.                    CDROM Request File Door for ROMBRAIN
  12.                                ---------------
  13.  
  14.    Welcome to the REQUEST BRAIN.  If you have more CDROMs than players, then
  15.    REQUEST BRAIN is for you!  This program works with the file request
  16.    feature of ROMBRAIN, the CDROM door.  REQUEST BRAIN will see who's
  17.    requested offline cdrom files, then allow the sysop to automatically
  18.    copy the files from the CDROM to the hard drive. Users may then download
  19.    their files using REQUEST BRAIN.  The sysop sets the number of days
  20.    requested files will be stored on the hard drive. Users may access the
  21.    files as many times as they like (in case of bad downloads) until the
  22.    files are automatically deleted by REQUEST BRAIN's maintenance function.
  23.  
  24.    GAP BBS: A notice will be written to the GAP\MAIN\USERINFO directory
  25.             to inform the user that their request is ready to download!
  26.  
  27.    REQUEST BRAIN requires the program DSZ.COM or DSZ.EXE in the path.
  28.    If you have an unregistered DSZ, Y-Modem G protocol will NOT function.
  29.    
  30.    Here's what the REQUEST BRAIN can do:
  31.  
  32.    Supports IBM ANSI Color and plain text mode (ASCII) 
  33.    for your callers who don't use IBM characters or don't use ANSI.
  34.    
  35.    REQUEST BRAIN supports com ports opened up to 115200 baud and as 
  36.    many of them as you can fit in the machine. This makes REQUEST BRAIN easy 
  37.    to set up on a multi-node system with GAP. REQUEST BRAIN will also 
  38.    support several other BBSes by the use of conversion programs available 
  39.    nearly everywhere.
  40.     
  41.    
  42.     REQUEST BRAIN Files
  43.     ----------------
  44.     REQUEST.EXE  <------------------ REQUEST BRAIN Program
  45.     REQUEST.DOC  <------------------ Sysop's Information
  46.     SAMPLE.CNF   <------------------ Sample Configuration File
  47.     CDHELP       <------------------ Online Download Editor Help Text
  48.     REGISTER.DOC <------------------ Registration information
  49.     EXTSX.BAT    <------------------ Batch File to call DSZ Xmodem
  50.     EXTS1.BAT    <------------------ Batch File to call DSZ Xmodem/1K
  51.     EXTSY.BAT    <------------------ Batch File to call DSZ Ymodem
  52.     EXTSZ.BAT    <------------------ Batch File to call DSZ Zmodem
  53.     EXTSF.BAT    <------------------ Batch File to call DSZ Xmodem/1K-G
  54.     EXTSG.BAT    <------------------ Batch File to call DSZ Ymodem-G
  55.     FILE_ID.DIZ  <------------------ Short Description of Program
  56.  
  57.    All of these files should be in this ZIP, if they are not, don't
  58.    take a chance! Call The Brainex System and get a good copy or view the 
  59.    file on a few local boards to see if you can find a complete copy.
  60.  
  61.    REQUEST BRAIN handles all of its file transfers from within the door.
  62.    A set of predefined protocol batch files are included for use with
  63.    the DSZ protocol engine. Parameters are passed to the protocol batch
  64.    files in the following order:
  65.    
  66.         %1 - Communications port
  67.         %2 - Baud rate
  68.         %3 - File name to send
  69.  
  70.  
  71.    SETUP
  72.    =====
  73.    The setup of REQUEST BRAIN is simple, all you need to do is create a
  74.    directory called REQUEST for REQUEST BRAIN and its files, then 
  75.    copy the files into that directory. After that you will need to edit
  76.    the sample SAMPLE.CNF file to match your BBS setup.
  77.  
  78.    You should rename this configuration file to REQUEST.CNF
  79.  
  80.    Sample REQUEST.CNF file:
  81.  
  82. C:\GAP
  83. The Brainex System
  84. GAP
  85. 0
  86. C:\GAP\CDROM
  87. 7
  88. E
  89. 110
  90. ================================================
  91. Line 1 - Path to data file (DOOR.SYS, DORINFO1.DEF, etc.)
  92. Line 2 - BBS Name
  93. Line 3 - BBS Type
  94.          GAP, PCB, WC3, RBBS, SF, or GEN for generic DOOR.SYS
  95. Line 4 - Registration Number
  96. Line 5 - Path to REQUEST.DAT file (Rombrain directory)
  97. Line 6 - Days to store user requested files
  98. Line 7 - CDROM Drive letter (CDROM drive used for copying files to hard drive)
  99. Line 8 - Sysop Level (for copying files from CD)
  100.  
  101.  
  102.    Once you have created your config file and filebase, you must then create
  103.    a batch file to run the door. A batch file for a GAP BBS looks like this:
  104.    
  105.      @ECHO OFF
  106.      SET DSZLOG=LOGx     <-------(Required for DSZ  x=Node Number)
  107.      CD \DOORS\REQUEST   
  108.      REQUEST REQUEST.CNF
  109.  
  110.    It is recommended but not required that you call REQUEST BRAIN with the
  111.    config file's name on the command line. If you don't, REQUEST BRAIN will
  112.    simply default to REQUEST.CNF.
  113.  
  114.    COM PORT OPTIONS
  115.    ================
  116.    To use a com port other than 1 or 2, use the following options:
  117.  
  118.    For COM3 using IRQ 4 and a base address of 3E8 (in hex):
  119.  
  120.    REQUEST REQUEST.CNF IRQ=4 BASE=3E8
  121.  
  122.    For COM4 using IRQ 3 and a base address of 2E8 (in hex):
  123.  
  124.    REQUEST REQUEST.CNF IRQ=3 BASE=2E8
  125.  
  126.    Com ports may be opened to 115,200 baud.
  127.  
  128.  
  129.  
  130.    Now create a directory on your hard drive that will hold the requested
  131.    files. As an example, we'll call it D:\ROMFILES.
  132.    
  133.    Next, create an ASCII text file named REQUEST.DAT.  The first line
  134.    should be the path name of the directory of the file requests. 
  135.    Using the above example, line 1 would read:
  136.  
  137.    D:\ROMFILES
  138.  
  139.    -------------------------------------------------------------------------
  140.    TECHNICAL NOTE:
  141.    When a user requests an offline file from Rombrain, the names of the files
  142.    requested will be added to the lines following D:\ROMFILES. It should
  143.    look something like this:
  144.  
  145.    D:\ROMFILES
  146.    "SYSOP","04-20-1992","Night Owl 5","E:\001A\315MOUSE.ZIP","R"
  147.    "SYSOP","04-20-1992","Night Owl 4","E:\012B\9600TEXT.ZIP","R"
  148.    -------------------------------------------------------------------------
  149.  
  150.    Place REQUEST.DAT in your ROMBRAIN directory. This will instruct Rombrain
  151.    to prompt users for offline file requests.
  152.  
  153.    Modify your DRIVE.DAT file to indicate which CDROMs are OFFLINE and ONLINE
  154.    by adding (ONLINE) or (OFFLINE) to the CDROM name. Here is an example
  155.    DRIVE.DAT file:
  156.  
  157. CARRS Night Owl Volume 6 ( ACTIVE),A,E:,C:\GAP\CDROM\PDSI006,50
  158. CARRS Night Owl Volume 5 (OFFLINE),A,E:,C:\GAP\CDROM\PDSI005,50
  159. Shareware Grab Bag       (OFFLINE),B,E:,C:\GAP\CDROM\GRABBAG,50
  160.  
  161. Consult the ROMBRAIN instructions for more details on DRIVE.DAT.
  162.  
  163.    You will also need to modify your doors menu files and the data
  164.    file that tells the BBS what your doors are and the security
  165.    level needed to access them. For GAP, these are respectively:
  166.    
  167.        DOORM
  168.        DOORMG
  169.        DOORS.DAT
  170.  
  171.    Please refer to your BBS documentation for details on 
  172.    setting up these files.
  173.  
  174.    If you are running multi-nodes, simply create a separate door
  175.    configuration file for each node, and number them. For instance,
  176.    for a 3 node system, you might have the following configuration
  177.    files:
  178.  
  179.        REQUEST1.CNF
  180.        REQUEST2.CNF
  181.        REQUEST3.CNF
  182.  
  183.    The only difference between the three would be the 1st line which
  184.    points to the default directory for the particular node.
  185.  
  186.    Another easy way to add the REQUEST BRAIN to GAP is to use Gap's
  187.    configuration option to create a SYSOP DEFINED COMMAND (consult Gap's 
  188.    docs for info on sysop defined commands). On The Brainex System I use 
  189.    REQUEST. The batch file to run the door is named REQUEST.BAT and placed 
  190.    in the BBS default directory (C:\GAP). When a caller types REQUEST at the 
  191.    main prompt, they are instantly taken to the REQUEST BRAIN.
  192.  
  193.    The following files are read during door initialization. They
  194.    must be present or the door will not operate.
  195.                                 
  196.        DOOR.SYS (or DORINFO1.DEF, CHAIN.TXT, SFDOORS.DAT)
  197.        REQUEST.DAT (Located in your RomBrain directory)
  198.                                     
  199.  
  200.    MAINTENANCE
  201.    ===========
  202.    To use the maintenance feature, change to the directory that contains 
  203.    REQUEST.EXE, then run the program with a /M added to the command line. 
  204.    
  205.    Example: REQUEST /M or REQUEST REQUEST1.CNF /M
  206.  
  207.    Sample command for a daily event batch file:
  208.  
  209.    D:
  210.    CD \REQUEST
  211.    REQUEST REQUEST1.CNF /M
  212.  
  213.    -----------------------------------------------------------------------
  214.    The following sysop functions are available while awaiting
  215.    keyboard input :
  216.  
  217.      F5      - Shell to DOS.
  218.      F8      - Twit user and return to BBS.
  219.     F10      - Initiate chat with user. ESC to exit chat.
  220.     CF10     - Answer user page bell.
  221.     Home     - Main user stats.
  222.     End      - Displays sysop keys available.
  223.     PgDn     - Secondary user stats.
  224.     Up Arrow - Increase user's time remaining by 5 minutes.
  225.     Dn Arrow - Decrease user's time remaining by 5 minutes.
  226.  
  227.  
  228.    One of the nicer features about using the TWIT key, is the user
  229.    is not told that "the sysop wants them to return to the BBS".
  230.    Instead, a very plain and simple message of "returning you to the
  231.    BBS" is displayed.  This way, the user is given no indication
  232.    that the sysop is hovering about.
  233.  
  234.    When using the F5 shell to DOS key, to return to the door
  235.    program, simply type EXIT at the DOS command prompt. It is not
  236.    necessary to change directories back to the door directory.
  237.    REQUEST BRAIN is smart enough to know which drive and directory the
  238.    door program is in and will reset the defaults upon return from
  239.    DOS.
  240.  
  241.    The Up and Down Arrow keys increase and decrease the user's time
  242.    respectively by 5 minutes for each press of the key. There is no
  243.    indication of what is occurring (except by the fact the user's
  244.    time remaining will change), so the sysop should try not to have
  245.    a lead finger. The increase or decrease is effective only while
  246.    the user is in REQUEST BRAIN.
  247.  
  248.    This version of REQUEST BRAIN is a DEMO. File Transfers are disabled.
  249.    It will become full featured upon registration. This door is released
  250.    "As Is" and there is *NO* warranty or guarantee that it will work for
  251.    you and not cause any problems. You have chosen to use this door, YOU are 
  252.    responsible for any unfortunate problems that may develop from its 
  253.    use or misuse. I will gladly listen to any suggestions or 
  254.    problems you may have, and I will do my best to fix whatever 
  255.    needs to be fixed. I can not be held responsible for any problems 
  256.    you may have, whether directly or indirectly due to the use of the
  257.    door or its utilities or associated files.
  258.    
  259.    Please read REGISTER.DOC for information on how you can register
  260.    your copy of REQUEST BRAIN. The download option will only work on
  261.    a registered version.
  262.  
  263.    For complete support, contact Stanley Sheff on The Brainex System.
  264.    Your questions will be quickly and cheerfully answered!
  265.  
  266.    Have Fun!
  267.    Stanley Sheff
  268.    The Brainex System
  269.    310-275-2344 HST
  270.    310-273-5234 MNP
  271.  
  272.